-
Notifications
You must be signed in to change notification settings - Fork 6.2k
Support constants in custom storage layout expression #15944
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: develop
Are you sure you want to change the base?
Conversation
944dc30
to
059349f
Compare
4aae044
to
00ee32e
Compare
"The base slot of the storage layout must evaluate to an integer." | ||
); | ||
return; | ||
if (integerType->isSigned()) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This could also be removed from here and then replace the assert in line 173
as suggested in a previous PR #15528 (comment)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Depends. The range check should catch it anyway and it provides a message that will be clearer to the user so I'd rather not check it. Removing this and adding an assert would be a better choice.
But I'm not sure if we will actually reach that check with constants. What happens in this case if you remove the isSigned()
. Will it fail in constant evaluator instead?
int constant X = -1;
contract C layout at X {}
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It still fails the range check and the message is indeed clearer as you said:
Error: The base slot of the storage layout evaluates to -1, which is outside the range of type uint256.
thank you for supporting constants! this is a huge composability unlock! |
Would this also apply to immutables? |
No, this only targets constants. Immutables are a little bit different and demand a different handling. |
We can't really support immutables here, because the layout must already be defined at creation time (constructor can initialize state variables), but their values can still change at that point. In case where they do not, the immutable can be replaced by a constant anyway. @matheusaaguiar Speaking of immutables, please make sure you have a test case against #15989. I.e. one showing that immutables are rejected even if they end up being treated as pure by the compiler. |
ec9785d
to
d1dbd2e
Compare
6396_error, | ||
baseSlotExpression.location(), | ||
"The base slot of the storage layout must evaluate to a rational number." | ||
"The base slot of the storage layout must evaluate to a rational integer number." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"The base slot of the storage layout must evaluate to a rational integer number." | |
"The base slot of the storage layout must evaluate to an integer." |
We could also say a rational number or an integer
, but not sure if the user will get the distinction. Unfortunately, out terminology here is a bit ambiguous.
contract C is A layout at A.x { } | ||
// ---- | ||
// TypeError 6396: (68-71): The base slot of the storage layout must evaluate to a rational number. | ||
// TypeError 1505: (68-71): The base slot expression cannot be evaluated during compilation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This one is weird. Why are we getting this and not something like:
Error: Member "x" not found or not visible after argument-dependent lookup in type(contract A).
Is ConstantEvaluator
silencing this error and just returning nullopt
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, ConstantEvaluator
can't handle member access. At the moment it can only process, literals, variables with no member acess from modules or other contracts and most of binary/unary operations.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Interesting. So apparently it's not just layouts, but ConstantEvaluator
does not support such constants in general. It does not seem hard to add that though. Looking at ConstantEvaluator
, it may be as simple as defining endVisit(MemberAccess)
similar to endVisit(Identifier)
it already has. I think we should do it: #16055.
This should not block this PR though. It's fine to leave it unsupported. You could add an explicit check for MemberAccess
to PostTypeContractLevelChecker
to issue a better message, but it will only catch cases where it's the top-level expression, so it's a half-measure.
import "A" as M; | ||
contract C layout at M.x{ } | ||
// ---- | ||
// TypeError 1505: (B:38-41): The base slot expression cannot be evaluated during compilation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This one should work without errors.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same for constant_initialized_from_cast.sol
address immutable a = 0x0000000000000000000000000000000000000001; | ||
uint immutable x = 1; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please also add an immutable that's not pure (i.e. one that's not initialized with a literal) since that's a separate case. Also a comment explaining how they differ.
contract C layout at ~uint(0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF) {} | ||
// ---- | ||
// TypeError 6396: (21-94): The base slot of the storage layout must evaluate to a rational number. | ||
// TypeError 1505: (21-94): The base slot expression cannot be evaluated during compilation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that users will be confused about why we can't evaluate this, because fundamentally it should be possible. It's documented, but maybe it would not hurt to just say that the constant evaluator is just too limited for this?
// TypeError 1505: (21-94): The base slot expression cannot be evaluated during compilation. | |
// TypeError 1505: (21-94): The base slot expression contains elements that are not yet supported by the internal constant evaluator and therefore cannot be evaluated at compilation time. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
contract at layout at type(uint).max { } | ||
// ---- | ||
// TypeError 6396: (22-36): The base slot of the storage layout must evaluate to a rational number. | ||
// TypeError 1505: (22-36): The base slot expression cannot be evaluated during compilation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was hoping this would work already in this PR, but apparently it's another thing that requires proper compile-time evaluation... #11183 (comment)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, the constant evaluator doesn't seem to be evaluating much based on this PR :D
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well, one thing that should work after the PR are simple constants initialized with expressions that we evaluate in unlimited precision. Please make sure that this is the case.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess that's the same situation as the test cases in test/libsolidity/syntaxTests/storageLayoutSpecifier/intermediate_operation_out_of_range.sol
, right?
I have added a few cases involving constants there.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is. We should still have at least one dedicated test whose goal is specifically to show that constants work.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you're also missing tests with some expression on constants or with constants that refer to other constants. These should all work.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is test/libsolidity/syntaxTests/storageLayoutSpecifier/constant_initialized_from_other_constant.sol
and test/libsolidity/syntaxTests/storageLayoutSpecifier/layout_specification_constant_in_expression.sol
which should cover that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is. We should still have at least one dedicated test whose goal is specifically to show that constants work.
I separated the constant cases and put them in their own file test/libsolidity/syntaxTests/storageLayoutSpecifier/constant_initialized_with_unlimited_arithmetic_expression.sol
.
d1dbd2e
to
0d68b8c
Compare
ced73ae
to
d19c5dc
Compare
d19c5dc
to
c76f976
Compare
This pull request is stale because it has been open for 14 days with no activity. |
This pull request is stale because it has been open for 14 days with no activity. |
This pull request is stale because it has been open for 14 days with no activity. |
c76f976
to
64e46af
Compare
This pull request is stale because it has been open for 14 days with no activity. |
This pull request is stale because it has been open for 14 days with no activity. |
This pull request is stale because it has been open for 14 days with no activity. |
6396_error, | ||
baseSlotExpression.location(), | ||
"The base slot of the storage layout must evaluate to a rational number." | ||
"The base slot of the storage layout must evaluate to an integer number." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"The base slot of the storage layout must evaluate to an integer number." | |
"The base slot of the storage layout must evaluate to an integer." |
An integer is a number, so this is a bit redundant. Also, couldn't you reuse error 1763? It's the same error and provides the same source location.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The concern I'd have with reusing error 1763
is that although it has the same location and message (which we could try to improve in both cases to differentiate them), it is a different case where the expression is a rational but it is fractional. In the case here of error 6396
the expression is neither a rational nor an integer number.
We can change the message here to The base slot of the storage layout must evaluate to a number.
to clarify and distinguish the errors. What do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's fine to cover both cases with the same error. The exact case is different (fractional literal vs non-integer constant), but conceptually the issue is the same with both - the user is trying to use something that's not an integer and we can't use that as a slot number.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Though, looking at the test cases, perhaps some clarification would be useful in cases where user is trying to use something like address
or bytesNN
since those can be initialized with an integer.
But that would be a completely different distinction. Meant to show that the type is the issue rather the value.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we then change the message here to The base slot type must be a numerical type
or something similar?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think I'd keep it as "must evaluate to an integer" and just do a single check. It's hard to phrase these things.
What I'd really want to do eventually would be to rewrite the docs to introduce clear terminology.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added a check to append a hint in the cases where the expression is of type address
or bytesN
.
test/libsolidity/syntaxTests/storageLayoutSpecifier/constant_divided_by_zero.sol
Show resolved
Hide resolved
The inability of the constant evaluator to evaluate much at all aside, the PR looks good, so please go over the comments, and we can merge soon. |
52a52f7
to
947b0df
Compare
Co-authored-by: Kamil Śliwak <[email protected]>
part of #15727.